home *** CD-ROM | disk | FTP | other *** search
/ Tech Arsenal 1 / Tech Arsenal (Arsenal Computer).ISO / tek-13 / ae_14.zip / AEMANUAL.TXT < prev    next >
Text File  |  1991-03-22  |  23KB  |  521 lines

  1.                        AE -- Another Editor
  2.                            Version 1.4
  3.  
  4.                               Manual
  5.  
  6.  
  7.  
  8.  
  9. Why Another Editor?
  10. -------------------
  11.  
  12.   There are already so many editors for MS-DOS, why take the 
  13.   trouble to invent the wheel once more? Well, I couldn't find 
  14.   an editor that suited my needs. I wanted one that:
  15.  
  16.   - could do simple ASCII editing, for writing programs and 
  17.   small texts.
  18.  
  19.   - had user-definable keyboard macros, in case I had some 
  20.   repetitive editing to do.
  21.  
  22.   - was small, so that it could be run from floppy.
  23.  
  24.   - was efficient: the most important options, like cursor 
  25.   movement and cutting/pasting must be done with a single 
  26.   keystroke.
  27.  
  28.   The result is AE. If you are an unexperienced PC user, then 
  29.   read on. I hope that this manual will explain enough to let 
  30.   you use AE effectively. If you are already familiar with other 
  31.   editors like the Norton editor or Borland's Turbo editors, you 
  32.   should have little trouble getting started with AE. You can 
  33.   get a list of AE's commands by pressing the F1 key. However, 
  34.   some of the details may not be immediately clear. Below, you 
  35.   will find a point-by point discussion of these.
  36.  
  37.  
  38. 1. Entrance and exit
  39. --------------------
  40.  
  41.   The editor is started by typing "AE" on the DOS command line. 
  42.   (If you hadn't guessed!) Alternatively, you can start editing 
  43.   an existing file by giving the filename as an argument (see
  44.   also the section "Loading and saving files" below).
  45.  
  46.   At any point during editing, when you are giving a command but 
  47.   have changed your mind, you can press the Escape key to exit. 
  48.   The command will not be executed, and AE will return to its 
  49.   normal state. Escape will not terminate the program. To do 
  50.   this, you must use the exit command Alt-X.
  51.  
  52.  
  53. 2. Loading and saving files
  54. ---------------------------
  55.  
  56.   You can load a file into AE either by typing it as an argument 
  57.   on the command line when starting (e.g. 'AE MYFILE.TXT'), or 
  58.   by pressing F3 once AE is running. 
  59.  
  60.   AE can handle filenames with wildcards. If the filename you 
  61.   enter contains a '?' (for any single character) or a '*' (for 
  62.   any series of characters), then you will get on your screen a 
  63.   list with the names of all files that match the wildcard
  64.   pattern. So, if you want to choose from all files in the 
  65.   current directory, try to load '*.*'. In the list, you can 
  66.   move a selection bar with the 'up' and 'down' keys, or PgUp 
  67.   and PgDn. You can also select a file from the file list by 
  68.   pressing the first letter of its name. So if for instance you 
  69.   press the "A" key repeatedly, the selection bar will step 
  70.   through all the file names beginning with an A. When you have 
  71.   selected the file you want, press Return to load it.
  72.  
  73.   On the bottom of the file list you will find the directories 
  74.   that the current directory is connected to. Directory names 
  75.   are indicated by a preceding "»". If you press Enter with the 
  76.   selection bar on a directory, AE will scan that directory and 
  77.   show you a new file list. In this way you can search the whole 
  78.   disk for the file you want.
  79.  
  80.   It is also possible to read the contents of another file and 
  81.   add them to the current one. This is the 'INSERT FILE' 
  82.   option. You can use it by pressing Shift-F3.
  83.  
  84.   Saving a file can be done by pressing F2. If the file does not 
  85.   have a name yet, AE will ask you to give it one. The name of 
  86.   the file you are editing can be seen on the statusline. If you 
  87.   want to store your file with a different name, then you should 
  88.   use Shift-F2. You will then be asked to enter the new filename.
  89.  
  90.   AE will notice if you have changed a file. You can also see 
  91.   this by the asterisk beside the filename on the statusline. If 
  92.   you have made changes and try to load another file without 
  93.   saving the old one first, AE will notify you and ask if the 
  94.   old file should be saved first. The same goes if you try to 
  95.   quit the program without having saved your file.
  96.  
  97.  
  98. 3. Cursor movement
  99. ------------------
  100.  
  101.   The keys to move the cursor are the same as just about every 
  102.   other editor for MS-DOS:
  103.  
  104.   up, down, left, right:   move one position in that direction 
  105.   Ctrl-left, Ctrl-right:   go to start of previous/next word 
  106.   Home, End:               go to begin/end of the current line 
  107.   Ctrl-Home, Ctrl-End:     go to first/last line on the screen 
  108.   PgUp,PgDn:               move one screenful up/down 
  109.   Ctrl-PgUp, Ctrl-PgDn:    go to begin/end of file
  110.  
  111.  
  112. 4. Typing characters and deleting them
  113. --------------------------------------
  114.  
  115.   This is, again, very much like other editors. When you type in 
  116.   a character, it will either be inserted into the text, or it 
  117.   will replace the character under the cursor. This depends on 
  118.   the mode, which is either 'Insert' or 'Overwrite'. You can 
  119.   switch between these modes by pressing the Ins key. The 
  120.   current mode is shown on the statusline .
  121.  
  122.   For some commands you will be asked to enter some text (like a 
  123.   filename for loading a file). The text will appear on the 
  124.   bottom line of the screen, temporarily erasing the statusline. 
  125.   Keys that work here usually have the same effect as in normal 
  126.   typing: left, right, Home, End, Delete and Backspace. 
  127.   Overwrite mode does not exist in these cases; characters are 
  128.   always inserted. Another peculiarity is that if the first key 
  129.   you press is a character key, the text that was present will 
  130.   be erased. If you start with any other key, you will modify 
  131.   the existing text. When you have finished your input, you can 
  132.   press Enter to proceed.
  133.  
  134.   To remove a character you can either use the Backspace or the 
  135.   Delete key. The latter will remove the character under the 
  136.   cursor, the former removes the one directly left to it. There
  137.   also are commands to remove more than one character at a time:
  138.   Delete line (Alt-L) deletes the current line, delete word 
  139.   forward (Alt-W) deletes text from the cursor to the beginning 
  140.   of the next word. (Words can be separated by spaces or any of 
  141.   the characters : ; , or.)
  142.  
  143.  
  144. 5. Cutting and pasting
  145. ----------------------
  146.  
  147.   The keys mentioned so far may be fine to add and remove a 
  148.   couple of characters, but to handle larger pieces of text you 
  149.   need to cut and paste. The first step for this is to move the 
  150.   cursor to one end of the piece of text, and then place a mark 
  151.   with the F5 key. The mark itself is not shown, but when you 
  152.   move the cursor away from the mark, you will see a highlighted 
  153.   piece between the mark and the cursor. This is called the 
  154.   block. Now you can delete the block (with Shift-F6), copy it 
  155.   to the paste buffer (with F7), or cut it (with F6). The 
  156.   difference between cut and copy is that cutting the block 
  157.   removes it from your text, while copy makes no changes in the 
  158.   text. Unless you have chosen to delete, the contents of the
  159.   block are now stored in the paste buffer. You can insert the 
  160.   contents of the paste buffer into a different part of the 
  161.   text, or into the text in a different window. Move the cursor
  162.   to the position where you want to insert it, then press F8. 
  163.   Pasting does not change the paste buffer, so pressing F8 more 
  164.   than once will insert multiple copies of the block.
  165.  
  166.   If you don't want to do anything with the block you can remove 
  167.   the mark with Shift-F5.
  168.  
  169.   The last option I want to mention is comparing the block to 
  170.   the paste buffer. This can be handy if you want to check 
  171.   whether two pieces of text are completely equal or not. After 
  172.   cutting or copying the first piece, select the second piece, 
  173.   then press Shift-F7. The result will be shown on the 
  174.   statusline.
  175.  
  176.  
  177. 6. Searching and replacing text
  178. -------------------------------
  179.  
  180.   You can search for a sequence of characters in the text and, 
  181.   optionally, replace it by another. These commands are started 
  182.   with F4 and Shift-F4 respectively. You will first be asked to 
  183.   enter the text to look for, the text to replace it with (if 
  184.   you have pressed Shift-F4), and the search options.
  185.  
  186.   Possible search options are R, I and N. The R option means 
  187.   reverse search. Normally the search will be from the cursor 
  188.   position forward. The I option tells AE to ignore the case of 
  189.   the characters, so that an uppercase "A" will be equal to a 
  190.   lowercase "a", etc. The N option is only valid for replacing, 
  191.   and stands for "no query". If you leave out the N option, AE 
  192.   will move the cursor to the next occurrence of the search 
  193.   text, show it and ask you if it should be replaced. You can 
  194.   then press Y or N, or Escape to stop. Unqueried replace will 
  195.   automatically scan the whole text from the cursor onwards, and 
  196.   replace every occurrence of the search text.
  197.  
  198.   Pressing Alt-R will repeat the last search/replace operation.
  199.  
  200.   There is another way to enter the sequence that must be 
  201.   searched for: select a block so that it contains the text you 
  202.   want to find, then press F4 or Shift-F4. You will see that the 
  203.   search text has already been filled in. In this way you can 
  204.   look for other occurrences of, say, a word.
  205.  
  206.   One more thing: if you want to search for a "new line" 
  207.   character, press Ctrl-Enter. (Just the Enter key won't do, 
  208.   because this is used to end your input.)
  209.  
  210.  
  211. 7. Multiple files
  212. -----------------
  213.  
  214.   In AE you can edit several files at the same time. You can 
  215.   view them in 'windows'. There are three windows, indicated by 
  216.   the letter A, B or C on the left of the statusline. Mind you, 
  217.   you can only view one window at a time; it takes up the whole 
  218.   screen. Switching between windows is done with F9 or Shift-F9 
  219.   (the latter switches in reverse direction).
  220.  
  221.  
  222. 8. Keyboard macros
  223. ------------------
  224.  
  225.   You can define 10 keyboard macros. To define a macro, press 
  226.   Alt-D. You will be asked for the number of the macro you want 
  227.   to define. After that, AE will record every key you press. 
  228.   Definition is ended by pressing Alt-D once more. (The 
  229.   definition mode is indicated by 'Def' on the statusline.) Now 
  230.   you can replay macro number 1 with Alt-1, number 2 with Alt-2, 
  231.   and so on to number 10 with Alt-0. AE will act just as if you 
  232.   had typed the whole series of keystrokes again. You can replay 
  233.   a macro while defining another one, so you can make it a 
  234.   powerful tool for repetitive tasks.
  235.  
  236.   As a small example, the following sequence of keys will define
  237.   a macro that deletes all text from the cursor to the end of 
  238.   the current line:
  239.   
  240.   <Alt-D> <1> <Return> <F5> <End> <Shift-F6> <Alt-D>
  241.  
  242.   Note: The occurrence of errors (like searching for a string 
  243.   that doesn't exist) will terminate macro execution. Macro 
  244.   execution does not work when you are entering DOS commands.
  245.  
  246.  
  247. 9. Setup
  248. --------
  249.  
  250.   You can set several preferences for working with AE. These
  251.   preferences can be set by pressing Shift-F1. On the statusline
  252.   you will then see a menu containing the options you can set.
  253.   They are listed below:
  254.  
  255.     Display     : Controls for the appearance of text on the 
  256.                   screen.
  257.       Colors             : Sets the color of normal text, block and
  258.                            statusline. Selecting this option 
  259.                            will cycle through several predefined 
  260.                            colour combinations. (Note: on 
  261.                            monochrome monitors there are only 
  262.                            two combinations. )
  263.       cursorType         : Sets the shape of the cursor.
  264.       Dots-for-spaces    : If this switch is on, spaces in the 
  265.                            text will be displayed as small dots.
  266.  
  267.     Environment : Miscellaneous options.
  268.       Keyclick           : If on, produces an audible click when 
  269.                            a key is pressed.
  270.       Bell               : Normally, when AE reports an error, 
  271.                            you will hear a beep. This can be 
  272.                            switched off.
  273.       Wordwrap           : See the section "Formatting text".
  274.       Tabs               : See the section "Tabs".
  275.       Autoindent         : See the section "Formatting text".
  276.       Insert             : Toggles between insert and overwrite
  277.                            mode (see also the section "Typing 
  278.                            characters and deleting them")
  279.  
  280.     File        : Several options to control the saving of files.
  281.       Exit-auto-save     : If this switch is on, AE will
  282.                            automatically save a changed file on 
  283.                            exiting the program.
  284.       Interval-auto-save : AE can periodically save your file.
  285.                            With this option you can set the 
  286.                            interval. (When 0, the option is off.)
  287.       Backup-files       : When on, AE will rename the old copy
  288.                            of your file before saving the new 
  289.                            version. The backup will have thew 
  290.                            extension "BAK".
  291.  
  292.     Printer     : Options to control the printing of your text. 
  293.                   See the section "Printing text".
  294.  
  295.     Save-setup  : Save the setup to a file (explained below).
  296.  
  297.   To select an option in the setup, press the capital letter in 
  298.   its name. So, to change the display colors, press Shift-F1
  299.   followed by "D" and "C", to set the tab spacing Shift-F1 plus
  300.   "E" and "T", and so on.
  301.  
  302.   When you set a switch option (one that can be on or off), you
  303.   will see a question on the screen followed by "Yes" or "No".
  304.   You can change the setting in two ways: by pressing the "Y" or
  305.   "N" key directly, or by pressing the spacebar until it is set
  306.   as you want it and then pressing Return.
  307.  
  308.   Every option that can be set with Shift-F1 is included in the 
  309.   setup. You can save this setup. AE will store it as 'AE.CFG' 
  310.   in the current directory. When AE is started, it searches for 
  311.   AE.CFG in the current directory. If it doesn't find the setup 
  312.   file there, it looks for the setup file in the directory where 
  313.   the program itself is. If this directory doesn't contain one 
  314.   either, it will use a default setup. This gives you the 
  315.   possibility to store several setup files in different 
  316.   directories. For example, you can store a setup for typing in 
  317.   programs in C:\PROGS, and store a different setup for writing 
  318.   letters in C:\TEXT. If you have stored AE.EXE in C:\UTIL then 
  319.   you can put a general purpose setup in that directory.
  320.  
  321.   The keyboard macros are also included in the setup file.
  322.  
  323.  
  324. 10. Printing text
  325. -----------------
  326.  
  327.   AE offers the possibility to print the text you are editing. 
  328.   You can either print the whole text (with Alt-P) or just the 
  329.   selected block (with Shift-F8).
  330.  
  331.   A couple of options are provided to get your text on the right 
  332.   spot on the paper. They are accessible by Shift-F1 P. If you 
  333.   set the page length to, say, 60, then AE will send a form feed 
  334.   to the printer after every 60 lines of text. Page numbers can 
  335.   be added. The top margin is the number of blank lines that is 
  336.   inserted at the beginning of every new page. The left margin 
  337.   is the number of spaces on the left of each printed line.
  338.  
  339.   Page breaks can be inserted by typing Ctrl-L (a.k.a. form 
  340.   feed character). This will appear in the text, but when 
  341.   printed it will cause the printer to advance the paper to the 
  342.   top of the next page.
  343.  
  344.   One last option is the "eject printer page" command. If you 
  345.   press Alt-E, AE will send a form feed to the printer, so that 
  346.   it will feed the paper to the next page.
  347.  
  348.  
  349. 11. MS-DOS commands
  350. -------------------
  351.  
  352.   You can interrupt editing to give a couple of DOS commands by 
  353.   pressing F10. AE will then start a DOS shell. To return to AE 
  354.   afterwards, type the command "exit" on the DOS command line.
  355.  
  356.   During these commands, AE will remain in memory, so there will 
  357.   be only about 200 to 300 kilobytes left, which is not enough 
  358.   to run large programs.
  359.  
  360.   Note: To start a DOS shell, AE reads the environment variable
  361.   COMSPEC. This variable indicates the directory and name of the
  362.   command interpreter that must be started to process your 
  363.   commands. If COMSPEC is not set, you will get an error message 
  364.   (COMMAND.COM not found). As a remedy, type the DOS command
  365.  
  366.   "SET COMSPEC=C:\COMMAND.COM"
  367.  
  368.   (or something similar, depending on where you have stored
  369.   COMMAND.COM), before you start AE.
  370.  
  371.  
  372. 12. Formatting text
  373. -------------------
  374.  
  375.   With AE you can create a text with left and right margins like 
  376.   the one you are now reading, by using autoindent and word 
  377.   wrap. If autoindent is on and you press Enter, AE will insert 
  378.   not only a new line, but also the same number of spaces that 
  379.   the previous line starts with. You can switch autoindent on 
  380.   and off in the setup (Shift-F1 E A).
  381.  
  382.   If word wrap is on, AE will truncate the lines you type when 
  383.   they have reached a certain length, and proceed on a new line. 
  384.   In this way, your text will be formatted as you type. However, 
  385.   if you insert text in the middle of a line, its length may 
  386.   exceed the wrap length. To reformat, press Alt-F. Note that 
  387.   this command reformats the whole paragraph, i.e. it goes on 
  388.   until it encounters the next blank line. You can set the line 
  389.   length for word wrap in the setup (Shift-F1 E W). A line 
  390.   length of 0 means word wrap is off. On the statusline you can 
  391.   see if autoindent and word wrap are switched on.
  392.  
  393.   There are two more commands to format text: Alt-C will center 
  394.   the current line (e.g. for titles) and Alt-J will justify it 
  395.   to the right margin. These, too, only work if word wrap is on.
  396.  
  397.  
  398. 13. Saving positions
  399. --------------------
  400.  
  401.   AE can store the current cursor position, to restore it later. 
  402.   This can be handy especially if you are programming a keyboard 
  403.   macro, or jumping to and fro in a text. The positions are 
  404.   saved last-in-first-out, meaning that the position that is 
  405.   restored is the one that was last saved. Saving a position is 
  406.   done with Alt-S, restoring a saved position with Alt-G.
  407.  
  408.  
  409. 14. Tabs
  410. --------
  411.  
  412.   Pressing the Tab key will move the cursor to the next tab 
  413.   stop, and Shift-Tab will move to the previous one. AE knows 
  414.   two ways to position tab stops: fixed-distance and aligned. If 
  415.   the tabs are aligned, AE will look on the line above for the 
  416.   next (or previous) beginning of a word. In that way you can 
  417.   get your text lined up neatly. With fixed-distance tab stops, 
  418.   the cursor will move to a certain column number. If you have 
  419.   set the tab spacing to, e.g. 8, then the tab stops will be on 
  420.   column 1, 9, 17, 25 and so on.
  421.  
  422.   You can set the tab spacing in the setup. A tab spacing of 0 
  423.   means aligned tabs.
  424.  
  425.  
  426. 15. Special characters
  427. ----------------------
  428.  
  429.   Special characters are those that are not present as normal 
  430.   keys on the keyboard. There are control characters, characters 
  431.   for foreign languages and graphical characters to make frames 
  432.   and the like. AE offers a couple of ways to insert them into 
  433.   your text.
  434.  
  435.   The ASCII table command (Alt-I) displays a table with the full 
  436.   IBM character set. You can choose from this table by moving 
  437.   the cursor to the desired character and pressing Enter. If 
  438.   you know the ASCII value of the character you want, you can 
  439.   also enter it by typing its number on the numerical keypad 
  440.   while holding down the Alt key.
  441.  
  442.   Control characters are the characters with ASCII value between 
  443.   0 and 31. You can enter control characters directly from the 
  444.   keyboard as Ctrl-A, Ctrl-B, etc. All control characters will 
  445.   be visible in your text, except for Ctrl-M, which is the line 
  446.   separator.
  447.  
  448.   Warning: Be careful with the Ctrl-Z character (ASCII value 
  449.   26). In MS-DOS, it serves as the end-of-file character. If you 
  450.   save a file containing this character, you will lose all text 
  451.   following it.
  452.  
  453.  
  454. 16. Miscellaneous
  455. -----------------
  456.  
  457.   Below you will find a list with the commands that have not 
  458.   been mentioned so far.
  459.  
  460.   * Match brackets (Alt-M). If the cursor is placed at a bracket 
  461.   and Alt-M is pressed, AE will search for the corresponding 
  462.   bracket. The search is forward when started at a left 
  463.   (opening) bracket, and backward when at a right bracket.
  464.  
  465.   * New (Alt-N). Clears the file buffer, i.e. it deletes the 
  466.   text that is loaded, so you can start working on a new file. 
  467.   If the old text has been changed, you will be asked if you 
  468.   want to save it first.
  469.  
  470.   * Toggle case (Alt-T). Reverses the case of the characters in 
  471.   the currently selected block.
  472.  
  473.   * Show version number (Alt-Z). Shows on the statusline the 
  474.   version number and date of the copy of AE that you are using.
  475.  
  476.  
  477. 17. The SPLIT and MERGE utilities
  478. ---------------------------------
  479.  
  480.   AE can only handle files that are smaller than 64 kilobytes
  481.   (65536 bytes). In most cases this will be enough. However, if 
  482.   you have a large file to edit, there is a way to get around 
  483.   this restriction. You can first split your file in several 
  484.   parts, edit the parts, and then glue them together again. The 
  485.   SPLIT and MERGE utilities are provided for this. They can be 
  486.   called from the DOS command line as follows:
  487.  
  488.   SPLIT <filename> [<chunksize>]
  489.  
  490.   Splits the file <filename> into smaller chunks. You can give
  491.   the size of the chunks in bytes or in kilobytes (respectively 
  492.   as a number, or a number followed by "k"). If you don't enter 
  493.   a chunksize, a default of 60 kilobytes will be taken.
  494.  
  495.   MERGE <part-1> [<part-2> ... <part-n>] <filename>
  496.  
  497.   Will read the files <part-1>, <part-2> and so on to <part-n> 
  498.   and put their contents in a big file <filename>. The names of 
  499.   the parts can contain wildcards ("?" or "*"). The files whose
  500.   names satisfy the wildcard pattern are read in the same order
  501.   as they appear in a directory listing.
  502.  
  503.   As an example, suppose you have a large file MYFILE.TXT of 150
  504.   kilobytes. The command 
  505.  
  506.   SPLIT MYFILE.TXT 50k 
  507.  
  508.   will generate three smaller files MYFILE.000, MYFILE.001 and 
  509.   MYFILE.002 of 50 kilobytes each, which you can edit with AE. 
  510.   When you have finished editing, you enter the command
  511.  
  512.   MERGE MYFILE.000 MYFILE.001 NEWFILE.TXT
  513.  
  514.   or
  515.  
  516.   MERGE MYFILE.00? NEWFILE.TXT
  517.  
  518.   and you will get a new file NEWFILE.TXT containing the edited 
  519.   contents of the parts.
  520.  
  521.